class Enlighten::IPrecompOutputProbeSet

└>Geo::IGeoSerialisable
└>Geo::IGeoReleasable

Handle to the LightTransport data for probesets.

Functions

Name	Description
Create()	Create a new empty IPrecompOutputProbeSet.
GetBoundingBoxBasisX()	Get the first basis vector of the non-axis aligned bounding box.
GetBoundingBoxBasisY()	Get the second basis vector of the non-axis aligned bounding box.
GetBoundingBoxBasisZ()	Get the third basis vector of the non-axis aligned bounding box.
GetBoundingBoxOrigin()	Get the origin of the non-axis aligned bounding box.
GetBuildParameters()	Read only access to the build parameters for this probe set.
GetId()	Return the unique ID of this light probe set.
GetName()	Get the full name.
GetNumProbes()	Return the number of probes contained in this light probe set.
GetProbeEnvironmentVisibility()	Access the light probe environment visibility. Data is encoded as a standard L2 spherical harmonic with 9 coefficients per probe.
GetProbePositions()	Access the light probe positions.
GetRegularGridResolutionX()	Get the resolution of the regular grid in the direction of the first bounding box basis vector.
GetRegularGridResolutionY()	Get the resolution of the regular grid in the direction of the second bounding box basis vector.
GetRegularGridResolutionZ()	Get the resolution of the regular grid in the direction of the third bounding box basis vector.
IsOctree()	Returns true if this probe set was generated for a probe octree.
IsRegularGrid()	Returns if this probe set is a probe grid.
Load(IGeoInputStream &, Geo::u32)	Load an instance of this class from an IGeoInputStream.
NonCopyable(NonCopyable &&)	Defaulted to allow move.
operator=(NonCopyable &&)	Defaulted to allow move.
Release()	Free this object that was created within the Enlighten libraries.
Save(IGeoStream &, Geo::u32)	Save an instance of this class to an IGeoStream.

static IPrecompOutputProbeSet* Enlighten::IPrecompOutputProbeSet::Create

public: IPrecompOutputProbeSet * Create()

Create a new empty IPrecompOutputProbeSet.

virtual const Geo::v128& Enlighten::IPrecompOutputProbeSet::GetBoundingBoxBasisX

public: const Geo::v128 & GetBoundingBoxBasisX() const

Get the first basis vector of the non-axis aligned bounding box.

virtual const Geo::v128& Enlighten::IPrecompOutputProbeSet::GetBoundingBoxBasisY

public: const Geo::v128 & GetBoundingBoxBasisY() const

Get the second basis vector of the non-axis aligned bounding box.

virtual const Geo::v128& Enlighten::IPrecompOutputProbeSet::GetBoundingBoxBasisZ

public: const Geo::v128 & GetBoundingBoxBasisZ() const

Get the third basis vector of the non-axis aligned bounding box.

virtual const Geo::v128& Enlighten::IPrecompOutputProbeSet::GetBoundingBoxOrigin

public: const Geo::v128 & GetBoundingBoxOrigin() const

Get the origin of the non-axis aligned bounding box.

virtual const IPrecompProbeSetBuildParameters* Enlighten::IPrecompOutputProbeSet::GetBuildParameters

public: const IPrecompProbeSetBuildParameters * GetBuildParameters() const

Read only access to the build parameters for this probe set.

virtual Geo::GeoGuid Enlighten::IPrecompOutputProbeSet::GetId

public: Geo::GeoGuid GetId() const

Return the unique ID of this light probe set.

virtual const char* Enlighten::IPrecompOutputProbeSet::GetName

public: const char * GetName() const

Get the full name.

virtual Geo::s32 Enlighten::IPrecompOutputProbeSet::GetNumProbes

public: Geo::s32 GetNumProbes() const

Return the number of probes contained in this light probe set.

virtual const float* Enlighten::IPrecompOutputProbeSet::GetProbeEnvironmentVisibility

public: const float * GetProbeEnvironmentVisibility() const

Access the light probe environment visibility. Data is encoded as a standard L2 spherical harmonic with 9 coefficients per probe.

virtual const Geo::v128* Enlighten::IPrecompOutputProbeSet::GetProbePositions

public: const Geo::v128 * GetProbePositions() const

Access the light probe positions.

virtual Geo::s32 Enlighten::IPrecompOutputProbeSet::GetRegularGridResolutionX

public: Geo::s32 GetRegularGridResolutionX() const

Get the resolution of the regular grid in the direction of the first bounding box basis vector.

virtual Geo::s32 Enlighten::IPrecompOutputProbeSet::GetRegularGridResolutionY

public: Geo::s32 GetRegularGridResolutionY() const

Get the resolution of the regular grid in the direction of the second bounding box basis vector.

virtual Geo::s32 Enlighten::IPrecompOutputProbeSet::GetRegularGridResolutionZ

public: Geo::s32 GetRegularGridResolutionZ() const

Get the resolution of the regular grid in the direction of the third bounding box basis vector.

virtual bool Enlighten::IPrecompOutputProbeSet::IsOctree

public: bool IsOctree() const

Returns true if this probe set was generated for a probe octree.

virtual bool Enlighten::IPrecompOutputProbeSet::IsRegularGrid

public: bool IsRegularGrid() const

Returns if this probe set is a probe grid.

This is only true if the probe positions form a single fully occupied regular grid and there are no duplicates or probe positions outside of the grid.

virtual bool Geo::IGeoSerialisable::Load

public: bool Load
(
IGeoInputStream & stream,
Geo::u32 section
)

Load an instance of this class from an IGeoInputStream.

The stream must be ready to read from. You can load sections of an object by passing a bitmask representing the desired sections rather than Iff::AllSectionsMask, which will load all sections. It is also safe to call this method on an object multiple times with different section arguments to load multiple parts.

Geo::NonCopyable::NonCopyable

public: NonCopyable
(
NonCopyable &&
)

Defaulted to allow move.

NonCopyable& Geo::NonCopyable::operator=

public: NonCopyable & operator=
(
NonCopyable &&
)

Defaulted to allow move.

virtual void Geo::IGeoReleasable::Release

public: void Release()

Free this object that was created within the Enlighten libraries.

Expect this to behave in a similar way to calling 'delete(this)'

virtual bool Geo::IGeoSerialisable::Save

public: bool Save
(
IGeoStream & stream,
Geo::u32 section
) const

Save an instance of this class to an IGeoStream.

The stream must be ready to write to. You can save sections of an object by passing a bitmask representing the desired sections rather than Iff::AllSectionsMask, which will save all sections that are available.